{\rtf1\ansi\ansicpg1252\cocoartf949\cocoasubrtf540
{\fonttbl\f0\fswiss\fcharset0 Helvetica;\f1\fswiss\fcharset0 ArialMT;}
{\colortbl;\red255\green255\blue255;}
\margl1440\margr1440\vieww17980\viewh14880\viewkind0
\pard\tx720\tx1440\tx2160\tx2880\tx3600\tx4320\tx5040\tx5760\tx6480\tx7200\tx7920\tx8640\ql\qnatural\pardirnatural

\f0\fs24 \cf0 The master README for Tips on operating the TWScripter BOT created by Colin Stagner (aka Cbs228)\
\
In addition to the /BotScript folder that contains this readme file, you will need the "Bot Script " script in the /Scripts directory\
\
\
\
\
\
\
\
Bot 101: An Introduction to TWSBOT\
\
\
 The following is a short (err, verbose) guide to the remote use of my TradeWars event tracker and responder bot, "TWSBOT." To start with, commands are passed via either SubSpace or private hail (Make sure you have a sneaky Subspace Channel). \
\
The commands take the following syntax:\
\
\
TWSBOT: anything\
\
\
where "anything" is the command to execute. Multiple commands can be included on the same line if they are separated by semicolons (";"). The following commands can be executed at any time, by anyone on the team:\
\
\
\pard\tx560\tx1120\tx1680\tx2240\tx2800\tx3360\tx3920\tx4480\tx5040\tx5600\tx6160\tx6720\ql\qnatural

\f1 \cf0 	\'95 	
\b save me
\b0  - This is probably the single most important command you will ever learn. I 
\i strongly suggest
\i0  that you put it in one of your macro buffers and memorize the key combination. When activated, it will attempt to move an available L4 planet to your location for an emergency pickup. The bot will make constant attempts to reach you for about 15 to 20 seconds, so all you have to remember to do after activating the command is to get figs down (or move to a sector with figs). Once the planet arrives, you will have a 
\b 5 second
\b0  window in which to land. After landing, you will be taken to a Limpet ScrapePoint, if one is available. Note: If you are going to include this command in a series of messages (e.x. calls to other save me scripts), make sure this one comes 
\i first
\i0 . (This is due to a helper design flaw I cannot fix.)\
	\'95 	
\b sound alarm
\b0  - This is my "page to keys" function. When activated, a loud alarm sound will be played over my speakers. Do not use this unless you require 
\i my immediate attention
\i0  to respond to an emergency situation. When present, my response time will probably be less than 60 seconds.\
	\'95 	
\b stop alarm
\b0  - My alarm can also be activated automatically by game events, which cause repeated warnings to be broadcast on subspace. Use this command to shut off the warnings and put the bot back into normal operating mode.\
	\'95 	
\b override alarm
\b0  - My alarm will not sound when the bot is operating in Extended Away Mode. Use this command to force it to sound, but don't use it if you know I am not here.\
	\'95 	
\b status
\b0  - This command prints my current status to SubSpace. It also has the secondary effect of updating the bot's internal status variables. Use this command whenever you have moved the planet I am on (or cause some other change to my location, such as a tow) so that the bot knows where it is (this is important). You may also use it just for the sake of viewing my status, of course. The status command is included in a Welcome message whenever a Friendly player logs in.\
	\'95 	
\b login
\b0  - Authenticates you for a higher level of access. This is useful only if you know the password. Always send this command, along with the access password, via private hail.\
\
\
The following commands require a 
\b login
\b0  to work.\
\
	\'95 	
\b initiate aevac
\b0  - This is the break-glass-in-case-of-emergency button. When activated, the automatic evacuation sequence (more info about that below) will start for my current location. It will use whatever method I have set. Under normal circumstances, it should not be necessary for anyone to use this as AEvac, as the name implies, will activate automatically if needed. This command also has the secondary effect of sounding the alarm.\
	\'95 	
\b move 
\i location
\i0\b0  - This uses TransWarp to move my ship to the specified 
\i location
\i0 . You may use either a WatchPoint (more info below) or a sector number with this command (or any other command that takes a 
\i location
\i0 ).\
	\'95 	
\b pwarp 
\i location
\i0\b0  - Works similar to the move command, but it uses a planet instead of a ship. If you want emergency 
\i save me
\i0  functionality, use that command instead of this one. A variant of this command, 
\b pwarp-fast
\b0 , can be used for two-man pgridding. (but don't try this while I'm not at keys!)\
	\'95 	
\b transport 
\i ship number
\i0\b0  - Uses the ship transporter to beam me to another ship.\
	\'95 	
\b land 
\i planet number
\i0\b0  - Lands on the specified planet and enters the citadel.\
	\'95 	
\b blast
\b0  - Blasts off of my current planet.\
	\'95 	
\b whereis 
\i location
\i0\b0  - This returns information about the specified 
\i location
\i0 . You can use this as a closest fighter finder or to convert symbolic WatchPoint names into sector numbers (and vice-versa). The results of this command will be sent to you via private hail for safety.\
	\'95 	
\b extern check
\b0  - This starts a comprehensive extern checker and outputs the results. However, be warned that sector numbers of problems (such as planet overloads) will not be sent over subspace radio but instead recorded to my logs. Normally, I will execute this command before each extern so there is usually no need to use this command.\
	\'95 	
\b worker help
\b0  - More information on my worker capabilities and how to use the commands. My worker module works similar to the reverend's. It should not be necessary for anyone but me to use these commands.\
	\'95 	
\b aattack help
\b0  - More information on my automatic attack capabilities and how to change my aattack mode.\
\
There are more commands, but those are the essentials. The complete set of commands is available via the 
\b help
\b0  command. Note that movement functions (
\b move
\b0 , 
\b pwarp
\b0 , etc) are failure-tolerant and won't do anything dumb like fuse my ship.\
\
Read on below for a list of bot concepts that you should be familiar with.\
\
\
\
 Bot Concepts:\
\
\
	\'95 	
\b WatchPoints
\b0  - A WatchPoint is a symbolic name used in place of a sector number. WatchPoints, commonly called WPs, are places of importance that are marked for tracking. Each WatchPoint has an alarm setting, watch distance (at what distance alerts are given), and its own unique AEvac setting.\
	\'95 	
\b Event Plotter
\b0  - The primary function of the bot is to plot events. When a fig, probe or limpet hit occurs, it will be plotted to each WatchPoint. Hits that fall within the designated watch distance of a WP will be reported and logged. If a WatchPoint has the Alarm setting enabled, the alarm will sound. Events can also trigger automated processes, such as AEvac. Event Plotter functions are automatic and cannot be disabled under any circumstances. Two special events, a photon strike and a ship-to-ship attack, are also processed.\
	\'95 	
\b Automatic Evacuation
\b0  - Commonly called "AEvac," this set of functions is dedicated to avoiding combat action in circumstances that are not favorable to my continued survival (such as when I am not at keys). They are triggered automatically from the Event Plotter. Methods include Standard ship and planet modes, an Automatic Defense (ADef) mode for Sentinel Defense of a sector, and the Planet Saver routine. AEvac can flee to random sectors or use "magical" WPs that begin with "EvacPoint." EvacPoints, or EPs, are an important part of the AEvac setup.\
	\'95 	
\b Planet Saver
\b0  - This is not to be confused with the 
\b save me
\b0  command, as they are two entirely different processes. The Planet Saver (PSAVE) is a subset of the AEvac module and can move planets to another location when bases are threatened. PSAVE can move an arbitrary number of planets in an arbitrary number of sectors to safety, and the list of planets to save is dynamically generated. The PSAVE module can operate under a variety of circumstances and has been battle-tested. PSAVE can use either a ship's transwarp drive and/or transporter pad to move planets.\
	\'95 	
\b Automatic Attack
\b0  - The AAttack module executes simple (and safe) attacks against gridders. It supports Planet Photon (pwarp photon) and Prediction attacks.\
	\'95 	
\b Worker
\b0  - The worker module can conduct buydowns, mega robs (if red), planetary negotiates, and product transfers. It was modeled on a similar set of functions created by the reverend. It also has the capability to conduct "one-touch" automatic mega rob sequences, but this can only be started locally. Use of the worker functions by anyone but me is discouraged.\
	\'95 	
\b Away Mode
\b0  - The Away mode changes certain aspects of the bot's operation. It is enabled by me when I will be AFK for an extended period of time. An Away Message is supported.\
	\'95 	
\b Automatic Reconnect
\b0  - Auto Reconnect will reconnect to the TWGS in case of a network or server failure. It is enabled and set up by me.\
\pard\tx720\tx1440\tx2160\tx2880\tx3600\tx4320\tx5040\tx5760\tx6480\tx7200\tx7920\tx8640\ql\qnatural\pardirnatural

\f0 \cf0 \
\
	BOT-MSG: Help and Command Summary for Local User: \
\
	 Use 'TWSBOT:' before all commands.     \
\
	 Local User Only:                                                             \
	    edit aevac - modifies global AEvac settings.                              \
	    edit id - change Bot ID and remote password.                              \
	    edit psave - change PSave modes.                                          \
	    edit reconnect - edits auto reconnect info.                               \
	    edit responder - change the bot Away Responder.                           \
	    enable remote commands - allows remote users to send commands.            \
	    <add/delete> friend - modifies friendly list.                             \
	    <add/edit/delete> watchpoint - modifies watchpoint db.\
\
	 Logged In Users:                                                             \
	    attack <mode> <args> - changes AAttack Mode.                              \
	    <enable/disable/init> aevac - change aevac event handling                 \
	    blast - blasts off of planet.                                             \
	    initiate aevac - begins AEvac sequence manually.                          \
	    land <number> - lands on planet.                                          \
	    lockout remote commands - disables remote commands.                       \
	    extern check - performs comprehensive extern check.                       \
	    logout - de-authenticates you.                                            \
	    move <WatchPoint/Sector> - moves the ship.                                \
	    pwarp <WatchPoint or Sector> - moves current planet.                      \
	    read mail - scans ship mail for events.                                   \
	    transport <ship> - transports to ship.                                    \
	    stop adef - stands down active ADef.                                      \
	    whereis <WatchPoint or Sector> - returns location/cfig to a sector.       \
	    worker help - displays available worker commands.   \
\
	 All Friendly Users:                                                          \
	    <sound/stop/override> alarm - sounds or silences the alarm.               \
	    help - displays this screen.                                              \
	    list - returns a listing of WatchPoints.                                  \
	    login <password> - authenticates/logs in user.                            \
	    <enable/disable> online watch - turns on/off Who's Online watch.          \
	    save me - saves you using planet                                          \
	    status - displays player/bot status.                                      \
\
	------------------------------------ \
\
	 BOT-MSG: Worker - Help - All Commands:                                       \
	    Notation Guide: method <required parameter> [optional parameter]          \
	    Omit angle brackets/brackets in your command.                             \
\
	    Buydown from Port: buy <product> [p #] [u #] [w]                          \
	    Negotiate w/ Port: neg <products> [p #]                                   \
	    Mega Rob Port    : mega                                                   \
	    Xfer Products    : xfer <product> [s #] [d #] [u #]    \
\
		EXAMPLE1:  xfer colos l c | s 118  | d 105 l u 1000\
		EXAMPLE2: xfer e s 22 d 45 u 100000\
        \
\
	    Products:                                                                 \
	       Ore Colos: (colos | c)                                                 \
	       Fuel Ore : (fuel | f)                                                  \
	       Organics : (org | o)                                                   \
	       Equipment: (equip | e)                                                 \
\
	    Parameters:                                                               \
	       Use Planet #       : (planet # | p #)                                  \
	       Source Planet      : (source # | s #)                                  \
	       Destination Planet : (destination # | d #)                             \
	       Move # of units    : (units # | u #)                                   \
	       Use Worst Haggle   : (worst-haggle | w)                                \
\
	    Use "TWSBOT: <method> help" for more help.                                \
\
\
	---------------------------------------\
\
	 BOT-MSG: Xfer Help:                                                          \
	    Move product between planets.                                             \
	    Syntax: xfer <product> [arguments]                                        \
	    Products:                                                                 \
	       Ore Colos: (colos | c)                                                 \
	       Fuel Ore: (fuel | f)                                                   \
	       Organics: (organics | o)                                               \
	       Equipment: (equipment | e)                                             \
	    Arguments (REQUIRED):                                                     \
	       (source # | s #)        take from planet number #                      \
	       (destination # | d #)   leave on planet number #                       \
	       (units # | u #)         # of units to take                             \
\
\
}